
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>stratified_plume_model.Model.save_txt &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="stratified_plume_model.Model.simulate" href="stratified_plume_model.Model.simulate.html" />
    <link rel="prev" title="stratified_plume_model.Model.save_sim" href="stratified_plume_model.Model.save_sim.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="stratified-plume-model-model-save-txt">
<h1>stratified_plume_model.Model.save_txt<a class="headerlink" href="#stratified-plume-model-model-save-txt" title="Permalink to this headline">¶</a></h1>
<dl class="method">
<dt id="stratified_plume_model.Model.save_txt">
<code class="sig-prename descclassname">Model.</code><code class="sig-name descname">save_txt</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">base_name</em>, <em class="sig-param">profile_path</em>, <em class="sig-param">profile_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/stratified_plume_model.html#Model.save_txt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#stratified_plume_model.Model.save_txt" title="Permalink to this definition">¶</a></dt>
<dd><p>Save the state space in ascii text format for exporting</p>
<p>Save the state space (dependent and independent variables) in an
ascii text file for exporting to other programs (e.g., Matlab).
Because the vertical coordinate is different for the inner and
outer plume solutions and because we want this data to be easily
loadable in Matlab (i.e., each column of data must have the same
number of rows), this method writes two data files, one for the
inner plume and one for the outer plume.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>base_name</strong><span class="classifier">str</span></dt><dd><p>Base file name for the output file.  This method appends ‘inner’
and ‘outer’ to the inner and outer solutions upstream of the
dot-extension.</p>
</dd>
<dt><strong>profile_path</strong><span class="classifier">str</span></dt><dd><p>String stating the file path to the ambient profile data relative
to the directory where <cite>fname</cite> will be saved.</p>
</dd>
<dt><strong>profile_info</strong><span class="classifier">str</span></dt><dd><p>Single line of text describing the ambient profile data.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="../bpm/bent_plume_model.Model.save_txt.html#bent_plume_model.Model.save_txt" title="bent_plume_model.Model.save_txt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bent_plume_model.Model.save_txt</span></code></a>, <a class="reference internal" href="../sbm/single_bubble_model.Model.save_txt.html#single_bubble_model.Model.save_txt" title="single_bubble_model.Model.save_txt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">single_bubble_model.Model.save_txt</span></code></a></dt><dd></dd>
</dl>
</div>
<p class="rubric">Notes</p>
<p>The output will be organized in columns, with each column as follows:</p>
<blockquote>
<div><p>0 : depth (m)
1-n : state space</p>
</div></blockquote>
<p>A header will be written to a separate file with <cite>yi_header</cite> and
<cite>yo_header</cite> appended to the base file name given above specifying
the exact contents of the state space.</p>
<p>These output files are written using the <cite>numpy.savetxt</cite> method.</p>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/spm.html">Overview of Stratified Plume Model Module</a><ul>
  <li><a href="stratified_plume_model.Model.html">stratified_plume_model.Model</a><ul>
      <li>Previous: <a href="stratified_plume_model.Model.save_sim.html" title="previous chapter">stratified_plume_model.Model.save_sim</a></li>
      <li>Next: <a href="stratified_plume_model.Model.simulate.html" title="next chapter">stratified_plume_model.Model.simulate</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/spm/stratified_plume_model.Model.save_txt.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>